Tangoe Mobile REST API

Create Orders or Change Management Requests using Activities.

Activities are synonymous with orders. They also capture change management requests such as change plans, change features, change ownership of lines, etc.

Replicating the Mobile REST API in your ITSM environment for ordering or change management requires the client to pass data formatted in a way that the mobile platform understands. For example, when you pass devices, plans, and features that need to be ordered, you need to pass us the IDs that are internal to the Tangoe Mobile System. There is a particular hierarchy of API calls that needs to happen when replicating the Tangoe Mobile API that can be found here.

The Mobile API mirrors how the Tangoe platform interface is set up to capture a robust scoping of catalog items based on user groups, titles, and many other configuration options. Each activity type has different fields required in the payload.

For mapping Activities, visit here. For all other attribute mappings, visit here.

To note, if your catalog of devices, plans, and features is limited, you can hard code these values in your system and not make multiple lookups for these particular IDs. Tangoe can supply the IDs to populate on your end, or you can make the GET calls on a frequency that works for you using the API and store the IDs in your system. We also recommend storing these values in a data table rather than having to make a code change later on.

Create a New Activity

Each activity type has different fields required. Below you will find expected example JSON payloads for each activity. At the bottom of this page, there is an example JSON response body. All activity endpoints are a POST method and will be the same URL https://{yourSubDomain}.thefutureis.mobi/1/activities. The difference with each payload will be the activity type ID and the required attributes that need to be passed. Suggested lookups will help find the required IDs needed for each activity if building a dynamic form.

NOTE: For each activity, the employee_id (the id for whom the activity is to be created for) should be included with each new request.

Activity Type Name and ID Numbers

Activity Name: Accessory Order

Activity Type ID: 7

Method: POST

ACTIVITY DEFINITION

Allows users to order accessories for a device.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested API Lookups: GET Method

These will help find the IDs needed for the required payload. Example URL: https://{subdomain}.thefutureis.mobi/1/accessories

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 7,
    "employee_id" : "10000",
    "shipping_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "state" : "IN",
      "zip" : "46220",
      "country_id" : 52123291,
      "ship_attention" : "Carter Beauford"
    },
    "accessory_order_items_attributes" : [{
      "accessory_id" : 5953,
      "quantity" : "1"
    },
    {
      "accessory_id" : 12612,
      "quantity" : "1"
    }],
    "comment" : "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Add/Remove Features

Activity Type ID: 15

Method: POST

ACTIVITY DEFINITION

Allows users to change extra, non-plan service features on a line (for example extra text packages or international data roaming).

ACTIVITY PROCESS FLOW

Activity is submitted and the request to route for additional approvals is set by the company. Once approved, the activity will be assigned to Tangoe and set to status In Progress. Tangoe will reach out to the carrier to add the features that were selected in the activity. If we are waiting on carrier confirmation to add the desired features, the activity may be marked as Await Carrier Response. Once the carrier completes the request, Tangoe copies the confirmation into the notes of the activity and marks the activity as Features Updated to complete the request.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 15,
    "employee_id" : "10000",
    "line_id" : 807778,
    "business_feature_ids" : [5247, 5256],
    "removed_feature_ids" : [1056566602],
    "comment" : "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Add Service To Existing Device

Activity Type ID: 37

Method: POST

ACTIVITY DEFINITION

Add service to an existing device. Allows users to add service to an existing device that may not be currently managed in the portal.

ACTIVITY PROCESS FLOW

Activity is submitted and will route for approval if set by the company. Once approved, Tangoe will receive the activity and will be marked as In Progress. Tangoe will reach out to the carrier to assign a new number to the existing equipment using the device information found within the activity. Tangoe will copy the confirmation into the notes of the activity and mark the activity as Order Placed to complete the request.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/carriers?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 37,
    "employee_id" : 10000,
    "carrier_id": 834256072,
    "device_identifier": "SERIAL_NUMBER_OR_IMEI_OR_MEID_OR_MSN_OR_ESN",
    "business_ref_device_id": 111722,
    "business_plan_id": 21333,
    "preferred_area_code" : "315",
    "preferred_calling_prefix" : "123",
    "preferred_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "zip" : "46220",
      "state" : "IN",
      "ship_attention" : "Mr. Pinkerton Quackers"
    },
    "comment" : "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Add Service To Managed Device

Activity Type ID: 40

Method: POST

ACTIVITY DEFINITION

Add service to a managed device. Allows users to add service to an existing managed device that currently does not have service.

ACTIVITY PROCESS FLOW

Activity will be submitted and will route for approval if set by the company. Once approved, the activity will be in status In Progress. Tangoe will reach out to the carrier to add service to the corporate device. The new number will be entered into the New Mobile Number field within the activity. Tangoe will also copy any confirmations into the notes of the activity and mark the request as Activated to complete the request.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/carriers?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 40,
    "employee_id" : "10000",
    "carrier_id" : 834256072,
    "shipping_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "zip" : "46220",
      "state" : "IN",
      "country_id" : 52123291,
      "ship_attention" : "Mr. Pinkerton Quackers"
    },
    "preferred_area_code" : "317",
    "preferred_calling_prefix" : "",
    "preferred_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "zip" : "46220",
      "state" : "IN",
      "ship_attention" : "Mr. Pinkerton Quackers"
    },
    "device_id" : 123,
    "business_plan_id" : 20428,
    "business_feature_ids" : [5247],
    "accessory_order_items_attributes" : [{
      "accessory_id" : 268815868,
      "quantity" : "1"
    }],
    "comment": "",
    "remote_activity_id": "the_remote_system_unique_id"
  }
}

Activity Name: Change Carrier

Activity Type ID: 4

Method: POST

ACTIVITY DEFINITION

Move a phone number to another carrier. Allows users to migrate service from one company carrier to another while keeping the phone number intact.

ACTIVITY PROCESS FLOW

Activity will be submitted and routed through the appropriate approvals if required by the company. Once approved, the activity will be assigned to Tangoe and In Progress status.

Tangoe then reaches out to the carrier to order the device, features, and plan requested as well as request the phone number to be moved from one carrier to another. Tangoe copies order confirmation(s) received from the carrier and order number into the notes of the activity. The new number will be entered into the New Mobile Number activity field and the order number into the Order Number activity field. Tangoe will mark the activity Ordered.

The device will ship and shipping confirmation(s) will be sent to the end-user and copied within the notes section of the activity. Tangoe copies the tracking number and shipper into the activity fields and copies confirmations into the notes section of the activity if any additional ones are sent over. Tangoe will then mark the activity as Shipped to complete.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/carriers?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 4,
    "employee_id" : "10000",
    "carrier_account_id" : 69607,
    "line_id" : 807729,
    "shipping_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "state" : "IN",
      "zip" : "46220",
      "country_id" : 52123291,
      "ship_attention" : "Name"
    },
    "business_plan_id" : 21333,
    "business_ref_device_id" : 26363,
    "comment" : "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Change Phone Number

Activity Type ID: 13

Method: POST

ACTIVITY DEFINITION

Request phone number change. Allows users to update the phone number for a device's line of service.

ACTIVITY PROCESS FLOW

Activity is submitted and will route for approval if required by the company. Tangoe will receive the activity as In Progress status once approved. Tangoe will reach out to the carrier to request the number change. Tangoe copies any confirmations from the disconnect from the carrier into the notes of the activity, along with the new phone number in the required field. Once the request is complete, the activity will be marked as Number Changed.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/countries?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 13,
    "employee_id" : "10000",
    "line_id" : 807778,
    "preferred_area_code" : "315",
    "preferred_calling_prefix" : "123",
    "preferred_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "zip" : "46220",
      "state" : "IN",
      "ship_attention" : "Mr. Pinkerton Quackers"
    },
    "comment" : "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Corporate Eligibility Check

Activity Type ID: 44

Method: POST

ACTIVITY DEFINITION

Check Corporate Eligibility for a Person.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/people?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 44,
    "employee_id" : "10000",
    "comment" : "this is a comment",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Device Assign

Activity Type ID: 24

Method: POST

ACTIVITY DEFINITION

Allows users to assign a device (equipment only) to a different person in the company.

ACTIVITY PROCESS FLOW

Activity is submitted and will route for approval if set by the company. Once approved, Tangoe will receive the request and will be set to In Progress status. Tangoe will reach out to the carrier to update the device records from one person to another within the company. Tangoe will copy the confirmation into the notes of the activity. Tangoe will mark the activity as Complete once the request is completed.

Activity payload attributes (required and nonrequired)

Note: Replacement_person_id is not employee_id. To get this ID, use https://{subdomain}.thefutureis.mobi/1/people/find\_one?employee_id={id}.

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/devices?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 24,
    "employee_id" : "10000",
    "device_id" : 807778,
    "replacement_person_id" : 555001218,
    "comment" : "this is a comment",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Device Purchase

Activity Type ID: 22

Method: POST

ACTIVITY DEFINITION

Allows users to order a device without a data or voice plan.

ACTIVITY PROCESS FLOW

Activity is submitted for approval if specified by the company. Once approved, the activity will state the status as in progress.

Tangoe will reach out to the carrier via phone, email, or carrier portal to order the new equipment. Tangoe will copy confirmation emails into the notes of the activity as well as notate the order number in the Order Number field within the activity. Tangoe will mark the activity as Ordered. The device will ship and the shipping confirmation(s) will be sent to the end-user and copied within the notes section of the activity.

Tangoe copies the tracking number and shipper into the activity fields and copies confirmations into the notes section of the activity if any additional ones are sent over. Tangoe will mark the activity as Shipped to complete the request.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/business_ref_devices?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 22,
    "employee_id" : "10000",
    "shipping_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "zip" : "46220",
      "state" : "IN",
      "country_id" : 52123291,
      "ship_attention" : "Mr. Pinkerton Quackers"
    },
    "business_ref_device_id" : 26363,
    "accessory_order_items_attributes" : [{
      "accessory_id" : 1785,
      "quantity" : "1"
    },
    {
      "accessory_id" : 1782,
      "quantity" : "1"
    }],
    "comment" : "this is a comment",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Device Replacement

Activity Type ID: 18

Method: POST

ACTIVITY DEFINITION

Replace a missing or defective device. Allows users to replace a device on a line of service if it has become lost, is stolen, or stops working.

ACTIVITY PROCESS FLOW

Activity will be submitted and will route for approval if set by the company. Once approved, Tangoe will receive the activity and will be set to status In Progress.

Tangoe will reach out to the carrier or Logistics (if seed stock is available for the company) to order the replacement device. Tangoe copies the order number or email into the notes of the activity and the order number into the Order Number field. Tangoe then marks the activity as Order Placed.

The device ships and the shipping confirmation is sent. Tangoe copies the tracking number and shipper into the activity fields and copies the confirmation email in the notes section. Tangoe marks the activity as Shipped to complete the request.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
    "activity": {
        "activity_type_id": 18,
        "line_id": 807778,
        "created_for_id": 9,
        "shipping_address_attributes": {
            "address1": "123 N Fake st.",
            "address2": "Apt. 0",
            "city": "Indianapolis",
            "zip": "46220",
            "country_id": 52123291,
            "state": "IN"
        },
        "comment": "this is a comment",
        "remote_activity_id": "the_remote_system_unique_id"
    },
    "warranty": {
        "lost_stolen": true,
        "damaged": false,
        "broken_seal": false,
        "neglect": false,
        "mishandled": false,
        "modified": false
    }
}

Activity Name: Device Return

Activity Type ID: 46

Method: POST

ACTIVITY DEFINITION

Allows users to return a company-owned device.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{ "activity":
  { "activity_type_id": 46,
    "employee_id": "10000",
    "shipping_address_attributes": {
      "address1": "123 N Fake St.",
      "address2": "Apt. 0",
      "city": "Indianapolis",
      "zip": "46220",
      "country_id": 52123291,
      "state": "IN",
      "ship_attention": "Captain Awesome"
    },
    "comment": "",
    "return_imei": 1234567891234567,
    "return_generic_serial": "12345656",
    "return_tracking_number": "fkj234r24tv4v",
    "return_courier_id": 1,
    "remote_activity_id" : "the_remote_system_unique_id",
    "custom_fields": {
        "1": {
            "custom_field_id": "Tangoe Custom Field ID",
            "value": "custom field value"
        }
    }
  }
}

Activity Name: Device Swap

Activity Type ID: 8

Method: POST

ACTIVITY DEFINITION

Switch a device on an active line. Allows users to change the device on a current line of service.

ACTIVITY PROCESS FLOW

End-user calls, emails, or chats for device activation requests. The Equipment Swap Activity will be created in the portal (allow for appropriate approvals if needed). Tangoe will need to gather the IMEI/MEID and ICCID of the new device received and input them into the activity fields. Tangoe completes the activation with the carrier. Tangoe will then mark the activity as Complete.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 8,
    "line_id" : 3583821,
    "device_identifier" : "asdfhdj8643",
    "replacement_ref_device_id" : 1046803160,
    "new_sim" : "1223445789000",
    "comment" :  "",
    "remote_activity_id" :  "the_remote_system_unique_id"
  }
}

Activity Name: Device Upgrade

Activity Type ID: 17

Method: POST

ACTIVITY DEFINITION

Activity that allows users to upgrade the device on a current line of service. Typically, this resets the service contract date for the line. Equipment purchase fees may apply.

ACTIVITY PROCESS FLOW

Activity will be submitted and will route through the appropriate approvals if required by the company. Once approved, the activity will be assigned to Tangoe and In Progress status.

Tangoe then reaches out to the carrier to order the device, features, and plan requested. Tangoe copies order confirmation(s) received from the carrier and order number into the notes of the activity and the order number also into the Order Number activity field. Tangoe will mark the activity Ordered.

The device will ship and the shipping confirmation(s) will be sent to the end-user and copied within the notes section of an activity. Tangoe then copies the tracking number and shipper into the activity fields and copies confirmations into the notes section of the activity if any additional ones are sent over. Tangoe will then mark the activity as shipped, to complete.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 17,
    "employee_id" : "10000",
    "line_id" : 807778,
    "shipping_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "zip" : "46220",
      "state" : "IN",
      "country_id" : 52123291,
      "ship_attention" : "Mr. Pinkerton Quackers"
    },
    "business_ref_device_id" : 26363,
    "business_plan_id" : 20428,
    "business_feature_ids" : [5247, 5248],
    "comment" : "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Enter Bring Your Own Mobile

Activity Type ID: 29

Method: POST

ACTIVITY DEFINITION

Enroll your device in the BYOM program. Allows users to activate corporate email on their personal devices.

ACTIVITY PROCESS FLOW

Activity is submitted and routed for approval if specified by the company. Once approved, the activity will be open and will show status as In Progress. Tangoe will add any additional features or applications needed as well as notate the carrier. Once the request is finalized and updated within Tangoe and the carrier, we will mark the activity as Complete.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/people?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 29,
    "employee_id" : "10000",
    "ref_device_id" : 1046768210,
    "device_identifier":  "90003559909483",
    "program_id" : 209,
    "signature" : "Pinkerton Quackers",
    "comment" : "this is a comment",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Leave Program

Activity Type ID: 33

Method: POST

ACTIVITY DEFINITION

Unroll from a Program. Allows users to deactivate corporate email on their personal devices.

ACTIVITY PROCESS FLOW

Activity is submitted and will route for approval if stipulated by the company. Once approved, the activity will be set to In Progress status. Tangoe will remove any internal applications and successfully unenroll the device and line from the BYOM program. Tangoe will copy any confirmation emails into the notes of the activity and mark the activity as Complete once resolved.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/program_memberships?enrollee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 33,
    "employee_id" : "10000",
    "program_membership_id" : 10000,
    "comment" : "this is a comment",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Line Cancel

Activity Type ID: 1

Method: POST

ACTIVITY DEFINITION

Cancel service on an active line. Allows users to terminate all services to a device.

ACTIVITY PROCESS FLOW

Activity will be submitted and will route for additional approvals if required by the company. Once approved, the request will go to Tangoe with the status of In Progress. Tangoe will reach out to the carrier to request the disconnect. Tangoe will copy any confirmations received into the notes of the activity and mark the activity as Complete.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 1,
    "employee_id": "10000",
    "line_id" : 807729,
    "comment" : "",
    "sleep_until" : "2022-11-16",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Line Assignment

Activity Type ID: 16

Method: POST

ACTIVITY DEFINITION

Allows users to assign a device and line of service to a different person in the company. There is typically no carrier fee to do this.

ACTIVITY PROCESS FLOW

Activity is submitted and will route for approval if specified by the company. Once approved, Tangoe will receive the activity in status In Progress. Tangoe will reach out to the carrier to update end-user information. Tangoe will copy any confirmations received from this request into the notes of the activity and mark the activity as Complete.

Activity payload attributes (required and nonrequired)

Note: Replacement_person_id is not employee_id. To get this ID, use https://{subdomain}.thefutureis.mobi/1/people/find_one?employee_id={id}.

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
      "activity_type_id" : 16,
      "employee_id" : "10000",
      "line_id" : 807728,
      "replacement_person_id" : 1831571,
      "label" : "carrier phone label",
      "comment" : "This is a comment",
      "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: New Line (with device activation)

Activity Type ID: 3

Method: POST

ACTIVITY DEFINITION

Activate a new line of service with a new device. Allows users to place orders for new lines of service and device activation. This typically involves equipment purchase, and activation, and may include accessory orders.

ACTIVITY PROCESS FLOW

Activity will be submitted and routed through the appropriate approvals if required by the company. Once approved, the activity will be assigned to Tangoe and In Progress status.

Tangoe then reaches out to the carrier to order the device, features, and plan requested. Tangoe copies order confirmation(s) received from the carrier, order number, and new number into the notes of the activity. The order number will be entered into the Order Number activity field and the new phone number in the New Mobile Number activity field. Tangoe will mark the activity Ordered.

The device will ship and the shipping confirmation(s) will be sent to the end-user and copied within the notes section of the activity. Tangoe copies the tracking number and shipper into the activity fields and copies confirmations into the notes section of the activity if any additional ones are sent over. Tangoe will mark the activity as Shipped to complete the request.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/carriers?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 3,
    "employee_id" : "10000",
    "carrier_id" : 834256072,
    "shipping_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "zip" : "46220",
      "state" : "IN",
      "country_id" : 52123291,
      "ship_attention" : "Mr. Pinkerton Quackers"
    },
    "preferred_area_code" : "315",
    "preferred_calling_prefix" : "123",
    "preferred_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "zip" : "46220",
      "state" : "IN",
      "ship_attention" : "Mr. Pinkerton Quackers"
    },
    "accessory_order_items_attributes" : [{
      "accessory_id" : 5953,
      "quantity" : "1"
    },
    {
      "accessory_id" : 12612,
      "quantity" : "1"
    }],
    "business_ref_device_id" : 26363,
    "business_plan_id" : 21333,
    "business_feature_ids" : [5247, 5248],
    "comment" : "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Order Sim Card

Activity Type ID: 38

Method: POST

ACTIVITY DEFINITION

Order an ICCID/SIM card for your existing line. Allows a user to order a new ICCID or SIM card for an existing device.

ACTIVITY PROCESS FLOW

An individual calls, emails, or chats in to order a new SIM or ICCID card for their device. Tangoe will create the Order ICCID/SIM Card Activity and allow it to route for approvals if set by the company. Once approved, the activity will be assigned to Tangoe and will be in status In Progress. Tangoe will place the order for the new SIM through the carrier. Tangoe will copy the order confirmation into the notes of the activity as well as the order number into the Order Number activity field.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : "38",
    "line_id" : 807778,
    "employee_id" : "10000",
    "shipping_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "zip" : "46220",
      "state" : "IN",
      "country_id" : 52123291,
      "ship_attention" : "Mr. Pinkerton Quackers"
    },
    "comment" : "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Pick Device

Activity Type ID: 45

Method: POST

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/business_ref_devices?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 45,
    "employee_id" : "10000",
    "business_ref_device_id" : 26372,
    "shipping_address_attributes": {
      "address1": "123 N Fake St.",
      "address2": "Apt. 0",
      "city": "Indianapolis",
      "zip": "46220",
      "country_id": 52123291,
      "state": "IN",
      "ship_attention": "Captain Awesome"
    },
    "comment": "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Plan Change

Activity Type ID: 14

Method: POST

ACTIVITY DEFINITION

Allows users to change the base service plan for an active device.

ACTIVITY PROCESS FLOW

Activity will be submitted and will route for approval if set by the company. Once approved, Tangoe will be assigned the activity and will be set to In Progress status. Tangoe will reach out to the carrier to change the desired plan selected within the activity. Tangoe will copy the order number or email into the notes section of the activity and the order number into the Order Number field. Tangoe will mark activity Plan Change to complete the request. An email will then be sent to notify the end-user of the plan change and any additional instructions needed if traveling.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 14,
    "employee_id" : "10000",
    "line_id" : 807778,
    "business_plan_id" : 20428,
    "business_feature_ids" : [5247, 5256],
    "comment" : "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Reactivate Line

Activity Type ID: 42

Method: POST

ACTIVITY DEFINITION

Reactivate a line of service. Allows users to request a previously deactivated line for reactivation.

ACTIVITY PROCESS FLOW

Activity is submitted and it will route for approvals if set by the company. Once approved, the activity will be assigned to Tangoe and will be set to status In Progress.

Tangoe will reach out to the carrier to request the reinstate service request for the disconnected line. Tangoe will copy the confirmation into the notes of the activity. If sent to the carrier via email and we are waiting on the carrier to complete the request, Tangoe will mark the activity as Await Carrier Response. Once the carrier has completed the reinstate request, Tangoe will mark the activity as active.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 42,
    "employee_id" : "10000",
    "line_id" : 807778,
    "comment" : "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Reset Voicemail Password

Activity Type ID: 20

Method: POST

ACTIVITY DEFINITION

Allows the user to request that their voicemail password be reset.

ACTIVITY PROCESS FLOW

An individual calls, emails, or chats in for a Reset Voicemail Password Reset request. Tangoe will create the Reset Voicemail Password activity and allow it to route for approval if set by the company. Once approved, Tangoe will reach out to the carrier to request the voicemail password be changed. Tangoe will copy any confirmations into the notes of the activity and mark the activity complete.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 20,
    "employee_id" : "10000",
    "line_id" : 807778,
    "comment" : "this is a comment",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Suspend

Activity Type ID: 2

Method: POST

ACTIVITY DEFINITION

Allows users to temporarily suspend service on an active line.

ACTIVITY PROCESS FLOW

Activity is submitted and will route for approval if required by the company. Once approved, Tangoe will receive the activity and will be in In Progress status. Tangoe will reach out to the carrier to suspend the line of service and will choose either with or without billing (whichever is required by the company). Tangoe copies the request/order number or email from the carrier into the notes of the activity as well as the Order Number field of the activity.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 2,
    "line_id" : 807778,
    "employee_id" : "10000",
    "comment" : "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Transfer Of Liability (personal to corporate)

Activity Type ID: 5

Method: POST

ACTIVITY DEFINITION

Portal activity that enables the user to transfer their personal line from their personal account to their current employer.

ACTIVITY PROCESS FLOW

After completing the activity submission, you will receive an email once the request is approved by your manager. We will work with the carrier to transfer the personal line to the corporate account and will complete the activity when all is successful. Once the end-user receives this email, the line has been successfully transferred to the corporate account.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/carriers?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 5,
    "employee_id" : "10000",
    "transfer_of_liability_attributes" : {
      "transfer_notes" : "just a couple of notes.",
      "phone_number" : "15166974878",
      "name" : "Pinkerton Quackers",
      "to_liability" : "corporate"
    },
    "business_ref_device_id" : 26363,
    "business_plan_id" : 21333,
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Transfer Of Liability and Change Carrier

Activity Type ID: 6

Method: POST

ACTIVITY DEFINITION

Change carrier and move the existing personal phone to corporate-liable.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/carriers?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 6,
    "employee_id" : "10000",
    "business_ref_device_id" : 156113,
    "business_plan_id" : 21333,
    "carrier_id" : "834256072",
    "transfer_of_liability_attributes" : {
      "transfer_notes" : "just a couple of notes.",
      "phone_number" : "15166974870",
      "name" : "Yashekia Scarlett",
      "to_liability" : "corporate",
      "transfer_date": "2023/06/23",
      "carrier_id" : "144678685",
      "account_number": "1234567",
      "password": "1234",
      "address_id": "2"
    },
    "shipping_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "zip" : "46220",
      "country_id" : 52123291,
      "state" : "IN",
      "ship_attention" : "Yashekia Scarlett"
    },
    "preferred_area_code" : "315",
    "preferred_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "zip" : "46220",
      "state" : "IN",
      "ship_attention" : "Yashekia Scarlett"
     }
    }
  }

Activity Name: Transfer Of Liability (corporate to personal)

Activity Type ID: 21

Method: POST

ACTIVITY DEFINITION

Leaving the company with own device. Allows users to move their corporate line to a personal-liable service with the same carrier.

ACTIVITY PROCESS FLOW

After completing the activity submission, you will receive an email once the request is approved by your manager. Then you will receive another email once we have placed the authorization for release on the end user's line of service with the carrier. Once the user receives this email, they are free to complete the transfer of the line to a personal account.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/people?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 21,
    "employee_id" : "10000",
    "line_id" : 807728,
    "transfer_of_liability_attributes" : {
      "transfer_notes" : "just a couple of notes.",
      "phone_number" : "5166974878",
      "name" : "name",
      "created_for_personal_email" : "pquakers@gmail.com",
      "to_liability" : "individual",
      "transfer_date": "2023/09/23"
    },
    "comment" : "this is a comment",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Transfer Of Liability with Upgrade

Activity Type ID: 31

Method: POST

ACTIVITY DEFINITION

Portal activity that enables the user to transfer their personal line to a company device.

ACTIVITY PROCESS FLOW

After completing the activity submission, you will receive an email once the request is approved by your manager. We will work with the carrier to transfer the personal line to the corporate account and will complete the activity when all is successful. Once the end-user receives this email, the line has been successfully transferred to the corporate account.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/carriers?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 31,
    "employee_id" : "10000",
    "shipping_address_attributes" : {
      "address1" : "123 N Fake St.",
      "address2" : "Apt. 0",
      "city" : "Indianapolis",
      "zip" : "46220",
      "country_id" : 52123291, //suggested lookup
      "state" : "IN",
      "ship_attention" : "Mr. Pinkerton Quackers"
    },
    "transfer_of_liability_attributes" : {
      "transfer_notes" : "just a couple of notes.",
      "phone_number" : "15166974870",
      "name" : "Yashekia Scarlett",
      "to_liability" : "corporate",
      "transfer_date": "2023/06/23",
      "carrier_id" : "144678685",
      "account_number": "1234567",
      "password": "1234",
      "address_id": "20"
    },
    "business_ref_device_id" : 26363, //suggested lookup
    "business_plan_id" : 21333, //suggested lookup
    "business_feature_ids" : [5247], //suggested lookup
    "comment" : "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Travel Request

Activity Type ID: 12

Method: POST

ACTIVITY DEFINITION

Allows users to enter International Feature Change requests with start and end travel dates. This Activity spawns a second Feature Change request upon travelers' return to remove international features.

ACTIVITY PROCESS FLOW

Activity is submitted and will route for approval if specified by the company. Once approved, the activity will state In Progress.

Tangoe will spawn the child tickets based on the original Travel Request activity. Activities will then spawn to Add or Remove the specified features listed in this activity. Tangoe will go in and Add or Remove the desired features and mark the activity as awaiting carrier response. Confirmation emails from the carrier can be placed into the notes of the activity.

The Travel Request Activity can be marked as Complete once the features have been updated. If we need to remove a feature on a certain date or when the end-user returns from their international trip, the activity will be slept within our system and will open back up and be in status In Progress to remove.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 12,
    "line_id" :  807778,
    "employee_id" : "10000",
    "pick_up_date" : "2015-03-20",
    "return_date" : "2015-03-26",
    "comment" : "I'm going to France and want a smartphone",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Unsuspend

Activity Type ID: 87

Method: POST

ACTIVITY DEFINITION

Reactivate a line that has been suspended. Allows users to temporarily unsuspend service on an active line.

ACTIVITY PROCESS FLOW

Activity will be submitted and will route for approvals if set by the company. Once approved, the activity will be assigned to Tangoe and will be set to In Progress status. Tangoe will reach out to the carrier to unsuspend the line. Tangoe will copy the confirmation email into the notes of the activity and the Order Number activity field. Tangoe will complete the activity and mark it as Unsuspend Line.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 87,
    "line_id" : 807778,
    "comment" : "",
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Activity Name: Upgrade Eligibility Check

Activity Type ID: 9

Method: POST

ACTIVITY DEFINITION

Check if a line is eligible for an upgrade. Allows users to determine device upgrade eligibility if not known.

ACTIVITY PROCESS FLOW

Activity is submitted, and once it is received by Tangoe, the activity will be in status In Progress. Tangoe will reach out to the carrier to obtain the eligibility of the line on the corporate account. Tangoe will copy any confirmations into the notes of the activity as well as inform the end-user or Admin of their eligibility date by filling in the appropriate fields with the correct dates and marking the activity as set date to complete.

Activity payload attributes (required and nonrequired)

Note: If there are attributes that need to be added to the payload, click here to see how to use custom fields.

Suggested Lookups: GET Method

These will help find the IDs needed for the payload. Example URL: https://{subdomain}.thefutureis.mobi/1/lines?employee_id={id}

Example JSON Payload

POST

{
  "activity" : {
    "activity_type_id" : 9,
    "employee_id" : "10000",
    "line_id" : 813736,
    "remote_activity_id" : "the_remote_system_unique_id"
  }
}

Example Response

Response payload after POSTING New Line Activity. Similar response for all other activities as well.

{
    "id": 4791063,
    "created_for_id": 1831571,
    "created_by_id": 2302502,
    "line_id": null,
    "completed_at": null,
    "shipping_address_id": 10017399,
    "order_number": null,
    "carrier_account_id": null,
    "preferred_area_code": "317",
    "ref_device_id": 1046769478,
    "tracking_number": null,
    "preferred_calling_prefix": null,
    "state": "approved",
    "business_id": 179,
    "new_sim": null,
    "order_sim": null,
    "assigned_to_id": 253054,
    "created_at": "2020-10-28T11:37:55.401-04:00",
    "updated_at": "2020-10-28T11:37:56.445-04:00",
    "comment": "",
    "return_date": null,
    "pick_up_date": null,
    "warranty": null,
    "plan_id": 1042457042,
    "carrier_id": 834256072,
    "activity_type_id": 3,
    "new_imei": null,
    "sleep_until": null,
    "label": "Pinkerton Quackers",
    "parent_activity_id": null,
    "lockbox_token": null,
    "device_id": null,
    "replacement_ref_device_id": 1046769478,
    "existing_ref_device_id": null,
    "replacement_person_id": null,
    "existing_person_id": null,
    "replacement_plan_id": null,
    "existing_plan_id": null,
    "lost_stolen": false,
    "currency": "USD",
    "plan_cost_cents": 6499,
    "device_cost_cents": 0,
    "approved_at": "2020-10-28T11:37:55.886-04:00",
    "shipping_method": "2 Day",
    "triggered_by_activity_id": null,
    "rpa_attempted": null,
    "original_carrier_account_id": null,
    "group_location_id": null,
    "cross_dock": false,
    "is_unsuspend": false,
    "activity_details": {
        "name": "New Line",
        "url": "https://sandbox2.7.stage.thefutureis.mobi/activities/4791063"
    },
    "field_data": {},
    "custom_fields": [],
    "parent_account": null,
    "cycle_end_day": null,
    "courier": null,
    "business_features": [],
    "removed_features": [],
    "activity_features": [],
    "assigned_to": {
        "id": 253054,
        "name_last": "Michels",
        "name_first": "Jae",
        "name_middle": null,
        "group_id": 68,
        "email": "sandboxmobility@mobiwm.com",
        "login": null,
        "employee_id": null,
        "created_at": "2011-04-11T16:53:41.000-04:00",
        "updated_at": "2020-10-06T16:20:23.845-04:00",
        "cost_center": "Product Development",
        "active": true,
        "customer_data": null,
        "group_name": "MOBI Employees"
    },
    "callback_logs": [],
    "created_for": {
        "id": 1831571,
        "name_last": "Quackers",
        "name_first": "Pinkerton",
        "name_middle": null,
        "group_id": 1605,
        "email": "administrator@sandbox.com",
        "login": "administrator@sandbox.com",
        "employee_id": "10000",
        "created_at": "2014-09-15T16:51:35.404-04:00",
        "updated_at": "2020-06-25T14:59:44.796-04:00",
        "cost_center": "CEO-001",
        "active": true,
        "customer_data": {},
        "group_name": "Demo Group A"
    },
    "created_by": {
        "id": 2302502,
        "name_last": "API",
        "name_first": "Tangoe",
        "name_middle": null,
        "group_id": 1375,
        "email": "abbott.admin@sandbox.com",
        "login": "abbott.admin@sandbox.com",
        "employee_id": "1234567",
        "created_at": "2015-05-04T13:33:50.900-04:00",
        "updated_at": "2020-10-28T11:37:10.529-04:00",
        "cost_center": "",
        "active": true,
        "customer_data": {},
        "group_name": "Sandbox Employees"
    },
    "plan": {
        "id": 1042457042,
        "name": "NBI Business Pooled Nation 900",
        "cost": {
            "fractional": "6499.0",
            "currency": {
                "id": "usd",
                "alternate_symbols": [
                    "US$"
                ],
                "decimal_mark": ".",
                "disambiguate_symbol": "US$",
                "html_entity": "$",
                "iso_code": "USD",
                "iso_numeric": "840",
                "name": "United States Dollar",
                "priority": 1,
                "smallest_denomination": 1,
                "subunit": "Cent",
                "subunit_to_unit": 100,
                "symbol": "$",
                "symbol_first": true,
                "thousands_separator": ","
            }
        },
        "minutes_anytime": "900",
        "minutes_evening": "Unlimited",
        "voice": false,
        "data": false,
        "carrier_code": "BPN649960",
        "voice_monthly_percentage": "0.0",
        "data_monthly_percentage": "0.0",
        "text_monthly_percentage": "0.0",
        "product_category": "Smartphone",
        "feature_names": {
            "feature_name": "Enhanced Push-to-Talk Add-on for Feature Phones"
        },
        "embedded_features": [],
        "supplier_sku": "sku88800405"
    },
    "ref_device": {
        "id": 1046769478,
        "name": "Apple iPhone 6 16GB - Space Gray",
        "description": "This update to the iPhone increases the screen size to 4.7-inch (diagonal) LED-backlit widescreen Multi-Touch display with IPS technology, improved 8-megapixel iSight camera with 1.5µ pixels and processor, adds NFC, has an A8 chip with 64-bit architecture and switches to a thinner, more rounded design. Other features are similar to the 5s, including a fingerprint Touch ID, Siri voice assistant, FaceTime camera. The iPhone 6 has a selection of models of up to 128GB of storage.",
        "image_file_name": "iphone_6_space_gray.png",
        "sku": "",
        "color": "Space Gray",
        "platform": "iPhone",
        "product_category": "Smart Phone",
        "manufacturer": "Apple",
        "consumer_sku": "",
        "size": "16GB",
        "manufacturer_sku": "",
        "carrier_name": "AT United States",
        "supplier_sku": null
    },
    "accessory_order_items": [],
    "shipping_address": {
        "id": 10017399,
        "address1": "123 N Fake St.",
        "address2": "Apt. 0",
        "city": "Indianapolis",
        "zip": "46220",
        "latitude": null,
        "longitude": null,
        "state": "IN",
        "ship_attention": "Captain Awesome",
        "iso3166_country": "UNITED STATES"
    },
    "preferred_address": {
        "id": 10017400,
        "address1": "123 Fake St.",
        "address2": null,
        "city": "San Juan",
        "zip": "00901",
        "latitude": null,
        "longitude": null,
        "state": "PR",
        "ship_attention": null,
        "iso3166_country": "UNITED STATES"
    }
}